home *** CD-ROM | disk | FTP | other *** search
/ Aminet 40 / Aminet 40 (2000)(Schatztruhe)[!][Dec 2000].iso / Aminet / dev / lang / Python16.lha / Python-1.6 / Lib / Python1.6 / distutils / cmd.py < prev    next >
Encoding:
Python Source  |  2000-08-13  |  17.4 KB  |  453 lines

  1. """distutils.cmd
  2.  
  3. Provides the Command class, the base class for the command classes
  4. in the distutils.command package.
  5. """
  6.  
  7. # created 2000/04/03, Greg Ward
  8. # (extricated from core.py; actually dates back to the beginning)
  9.  
  10. __revision__ = "$Id: cmd.py,v 1.22 2000/08/13 00:36:47 gward Exp $"
  11.  
  12. import sys, os, string, re
  13. from types import *
  14. from distutils.errors import *
  15. from distutils import util, dir_util, file_util, archive_util, dep_util
  16.  
  17.  
  18. class Command:
  19.     """Abstract base class for defining command classes, the "worker bees"
  20.     of the Distutils.  A useful analogy for command classes is to think of
  21.     them as subroutines with local variables called "options".  The options
  22.     are "declared" in 'initialize_options()' and "defined" (given their
  23.     final values, aka "finalized") in 'finalize_options()', both of which
  24.     must be defined by every command class.  The distinction between the
  25.     two is necessary because option values might come from the outside
  26.     world (command line, config file, ...), and any options dependent on
  27.     other options must be computed *after* these outside influences have
  28.     been processed -- hence 'finalize_options()'.  The "body" of the
  29.     subroutine, where it does all its work based on the values of its
  30.     options, is the 'run()' method, which must also be implemented by every
  31.     command class.
  32.     """
  33.  
  34.     # -- Creation/initialization methods -------------------------------
  35.  
  36.     def __init__ (self, dist):
  37.         """Create and initialize a new Command object.  Most importantly,
  38.         invokes the 'initialize_options()' method, which is the real
  39.         initializer and depends on the actual command being
  40.         instantiated.
  41.         """
  42.         # late import because of mutual dependence between these classes
  43.         from distutils.dist import Distribution
  44.  
  45.         if not isinstance (dist, Distribution):
  46.             raise TypeError, "dist must be a Distribution instance"
  47.         if self.__class__ is Command:
  48.             raise RuntimeError, "Command is an abstract class"
  49.  
  50.         self.distribution = dist
  51.         self.initialize_options ()
  52.  
  53.         # Per-command versions of the global flags, so that the user can
  54.         # customize Distutils' behaviour command-by-command and let some
  55.         # commands fallback on the Distribution's behaviour.  None means
  56.         # "not defined, check self.distribution's copy", while 0 or 1 mean
  57.         # false and true (duh).  Note that this means figuring out the real
  58.         # value of each flag is a touch complicated -- hence "self.verbose"
  59.         # (etc.) will be handled by __getattr__, below.
  60.         self._verbose = None
  61.         self._dry_run = None
  62.  
  63.         # Some commands define a 'self.force' option to ignore file
  64.         # timestamps, but methods defined *here* assume that
  65.         # 'self.force' exists for all commands.  So define it here
  66.         # just to be safe.
  67.         self.force = None
  68.  
  69.         # The 'help' flag is just used for command-line parsing, so
  70.         # none of that complicated bureaucracy is needed.
  71.         self.help = 0
  72.  
  73.         # 'finalized' records whether or not 'finalize_options()' has been
  74.         # called.  'finalize_options()' itself should not pay attention to
  75.         # this flag: it is the business of 'ensure_finalized()', which
  76.         # always calls 'finalize_options()', to respect/update it.
  77.         self.finalized = 0
  78.  
  79.     # __init__ ()
  80.  
  81.  
  82.     def __getattr__ (self, attr):
  83.         if attr in ('verbose', 'dry_run'):
  84.             myval = getattr (self, "_" + attr)
  85.             if myval is None:
  86.                 return getattr (self.distribution, attr)
  87.             else:
  88.                 return myval
  89.         else:
  90.             raise AttributeError, attr
  91.  
  92.  
  93.     def ensure_finalized (self):
  94.         if not self.finalized:
  95.             self.finalize_options ()
  96.         self.finalized = 1
  97.         
  98.  
  99.     # Subclasses must define:
  100.     #   initialize_options()
  101.     #     provide default values for all options; may be customized by
  102.     #     setup script, by options from config file(s), or by command-line
  103.     #     options
  104.     #   finalize_options()
  105.     #     decide on the final values for all options; this is called
  106.     #     after all possible intervention from the outside world
  107.     #     (command-line, option file, etc.) has been processed
  108.     #   run()
  109.     #     run the command: do whatever it is we're here to do,
  110.     #     controlled by the command's various option values
  111.  
  112.     def initialize_options (self):
  113.         """Set default values for all the options that this command
  114.         supports.  Note that these defaults may be overridden by other
  115.         commands, by the setup script, by config files, or by the
  116.         command-line.  Thus, this is not the place to code dependencies
  117.         between options; generally, 'initialize_options()' implementations
  118.         are just a bunch of "self.foo = None" assignments.
  119.            
  120.         This method must be implemented by all command classes.
  121.         """
  122.         raise RuntimeError, \
  123.               "abstract method -- subclass %s must override" % self.__class__
  124.         
  125.     def finalize_options (self):
  126.         """Set final values for all the options that this command supports.
  127.         This is always called as late as possible, ie.  after any option
  128.         assignments from the command-line or from other commands have been
  129.         done.  Thus, this is the place to to code option dependencies: if
  130.         'foo' depends on 'bar', then it is safe to set 'foo' from 'bar' as
  131.         long as 'foo' still has the same value it was assigned in
  132.         'initialize_options()'.
  133.  
  134.         This method must be implemented by all command classes.
  135.         """
  136.         raise RuntimeError, \
  137.               "abstract method -- subclass %s must override" % self.__class__
  138.  
  139.  
  140.     def dump_options (self, header=None, indent=""):
  141.         from distutils.fancy_getopt import longopt_xlate
  142.         if header is None:
  143.             header = "command options for '%s':" % self.get_command_name()
  144.         print indent + header
  145.         indent = indent + "  "
  146.         for (option, _, _) in self.user_options:
  147.             option = string.translate(option, longopt_xlate)
  148.             if option[-1] == "=":
  149.                 option = option[:-1]
  150.             value = getattr(self, option)
  151.             print indent + "%s = %s" % (option, value)
  152.  
  153.  
  154.     def run (self):
  155.         """A command's raison d'etre: carry out the action it exists to
  156.         perform, controlled by the options initialized in
  157.         'initialize_options()', customized by other commands, the setup
  158.         script, the command-line, and config files, and finalized in
  159.         'finalize_options()'.  All terminal output and filesystem
  160.         interaction should be done by 'run()'.
  161.  
  162.         This method must be implemented by all command classes.
  163.         """
  164.  
  165.         raise RuntimeError, \
  166.               "abstract method -- subclass %s must override" % self.__class__
  167.  
  168.     def announce (self, msg, level=1):
  169.         """If the current verbosity level is of greater than or equal to
  170.         'level' print 'msg' to stdout.
  171.         """
  172.         if self.verbose >= level:
  173.             print msg
  174.  
  175.     def debug_print (self, msg):
  176.         """Print 'msg' to stdout if the global DEBUG (taken from the
  177.         DISTUTILS_DEBUG environment variable) flag is true.
  178.         """
  179.         from distutils.core import DEBUG
  180.         if DEBUG:
  181.             print msg
  182.         
  183.  
  184.  
  185.     # -- Option validation methods -------------------------------------
  186.     # (these are very handy in writing the 'finalize_options()' method)
  187.     # 
  188.     # NB. the general philosophy here is to ensure that a particular option
  189.     # value meets certain type and value constraints.  If not, we try to
  190.     # force it into conformance (eg. if we expect a list but have a string,
  191.     # split the string on comma and/or whitespace).  If we can't force the
  192.     # option into conformance, raise DistutilsOptionError.  Thus, command
  193.     # classes need do nothing more than (eg.)
  194.     #   self.ensure_string_list('foo')
  195.     # and they can be guaranteed that thereafter, self.foo will be
  196.     # a list of strings.
  197.  
  198.     def _ensure_stringlike (self, option, what, default=None):
  199.         val = getattr(self, option)
  200.         if val is None:
  201.             setattr(self, option, default)
  202.             return default
  203.         elif type(val) is not StringType:
  204.             raise DistutilsOptionError, \
  205.                   "'%s' must be a %s (got `%s`)" % (option, what, val)
  206.         return val
  207.  
  208.     def ensure_string (self, option, default=None):
  209.         """Ensure that 'option' is a string; if not defined, set it to
  210.         'default'.
  211.         """
  212.         self._ensure_stringlike(option, "string", default)
  213.  
  214.     def ensure_string_list (self, option):
  215.         """Ensure that 'option' is a list of strings.  If 'option' is
  216.         currently a string, we split it either on /,\s*/ or /\s+/, so
  217.         "foo bar baz", "foo,bar,baz", and "foo,   bar baz" all become
  218.         ["foo", "bar", "baz"].
  219.         """
  220.         val = getattr(self, option)
  221.         if val is None:
  222.             return
  223.         elif type(val) is StringType:
  224.             setattr(self, option, re.split(r',\s*|\s+', val))
  225.         else:
  226.             if type(val) is ListType:
  227.                 types = map(type, val)
  228.                 ok = (types == [StringType] * len(val))
  229.             else:
  230.                 ok = 0
  231.  
  232.             if not ok:
  233.                 raise DistutilsOptionError, \
  234.                       "'%s' must be a list of strings (got %s)" % \
  235.                       (option, `val`)
  236.         
  237.     def _ensure_tested_string (self, option, tester,
  238.                                what, error_fmt, default=None):
  239.         val = self._ensure_stringlike(option, what, default)
  240.         if val is not None and not tester(val):
  241.             raise DistutilsOptionError, \
  242.                   ("error in '%s' option: " + error_fmt) % (option, val)
  243.  
  244.     def ensure_filename (self, option):
  245.         """Ensure that 'option' is the name of an existing file."""
  246.         self._ensure_tested_string(option, os.path.isfile,
  247.                                    "filename",
  248.                                    "'%s' does not exist or is not a file")
  249.  
  250.     def ensure_dirname (self, option):
  251.         self._ensure_tested_string(option, os.path.isdir,
  252.                                    "directory name",
  253.                                    "'%s' does not exist or is not a directory")
  254.  
  255.  
  256.     # -- Convenience methods for commands ------------------------------
  257.  
  258.     def get_command_name (self):
  259.         if hasattr (self, 'command_name'):
  260.             return self.command_name
  261.         else:
  262.             return self.__class__.__name__
  263.  
  264.  
  265.     def set_undefined_options (self, src_cmd, *option_pairs):
  266.         """Set the values of any "undefined" options from corresponding
  267.         option values in some other command object.  "Undefined" here means
  268.         "is None", which is the convention used to indicate that an option
  269.         has not been changed between 'initialize_options()' and
  270.         'finalize_options()'.  Usually called from 'finalize_options()' for
  271.         options that depend on some other command rather than another
  272.         option of the same command.  'src_cmd' is the other command from
  273.         which option values will be taken (a command object will be created
  274.         for it if necessary); the remaining arguments are
  275.         '(src_option,dst_option)' tuples which mean "take the value of
  276.         'src_option' in the 'src_cmd' command object, and copy it to
  277.         'dst_option' in the current command object".
  278.         """
  279.  
  280.         # Option_pairs: list of (src_option, dst_option) tuples
  281.  
  282.         src_cmd_obj = self.distribution.get_command_obj (src_cmd)
  283.         src_cmd_obj.ensure_finalized ()
  284.         for (src_option, dst_option) in option_pairs:
  285.             if getattr (self, dst_option) is None:
  286.                 setattr (self, dst_option,
  287.                          getattr (src_cmd_obj, src_option))
  288.  
  289.  
  290.     def get_finalized_command (self, command, create=1):
  291.         """Wrapper around Distribution's 'get_command_obj()' method: find
  292.         (create if necessary and 'create' is true) the command object for
  293.         'command', call its 'ensure_finalized()' method, and return the
  294.         finalized command object.
  295.         """
  296.         cmd_obj = self.distribution.get_command_obj (command, create)
  297.         cmd_obj.ensure_finalized ()
  298.         return cmd_obj
  299.  
  300.     # XXX rename to 'get_reinitialized_command()'? (should do the
  301.     # same in dist.py, if so)
  302.     def reinitialize_command (self, command):
  303.         return self.distribution.reinitialize_command(command)
  304.  
  305.     def run_command (self, command):
  306.         """Run some other command: uses the 'run_command()' method of
  307.         Distribution, which creates and finalizes the command object if
  308.         necessary and then invokes its 'run()' method.
  309.         """
  310.         self.distribution.run_command (command)
  311.  
  312.  
  313.     # -- External world manipulation -----------------------------------
  314.  
  315.     def warn (self, msg):
  316.         sys.stderr.write ("warning: %s: %s\n" %
  317.                           (self.get_command_name(), msg))
  318.  
  319.  
  320.     def execute (self, func, args, msg=None, level=1):
  321.         util.execute(func, args, msg, self.verbose >= level, self.dry_run)
  322.  
  323.  
  324.     def mkpath (self, name, mode=0777):
  325.         dir_util.mkpath(name, mode,
  326.                         self.verbose, self.dry_run)
  327.  
  328.  
  329.     def copy_file (self, infile, outfile,
  330.                    preserve_mode=1, preserve_times=1, link=None, level=1):
  331.         """Copy a file respecting verbose, dry-run and force flags.  (The
  332.         former two default to whatever is in the Distribution object, and
  333.         the latter defaults to false for commands that don't define it.)"""
  334.  
  335.         return file_util.copy_file(
  336.             infile, outfile,
  337.             preserve_mode, preserve_times,
  338.             not self.force,
  339.             link,
  340.             self.verbose >= level,
  341.             self.dry_run)
  342.  
  343.  
  344.     def copy_tree (self, infile, outfile,
  345.                    preserve_mode=1, preserve_times=1, preserve_symlinks=0,
  346.                    level=1):
  347.         """Copy an entire directory tree respecting verbose, dry-run,
  348.         and force flags.
  349.         """
  350.         return dir_util.copy_tree(
  351.             infile, outfile, 
  352.             preserve_mode,preserve_times,preserve_symlinks,
  353.             not self.force,
  354.             self.verbose >= level,
  355.             self.dry_run)
  356.  
  357.  
  358.     def move_file (self, src, dst, level=1):
  359.         """Move a file respecting verbose and dry-run flags."""
  360.         return file_util.move_file (src, dst,
  361.                                     self.verbose >= level,
  362.                                     self.dry_run)
  363.  
  364.  
  365.     def spawn (self, cmd, search_path=1, level=1):
  366.         """Spawn an external command respecting verbose and dry-run flags."""
  367.         from distutils.spawn import spawn
  368.         spawn (cmd, search_path,
  369.                self.verbose >= level,
  370.                self.dry_run)
  371.  
  372.  
  373.     def make_archive (self, base_name, format,
  374.                       root_dir=None, base_dir=None):
  375.         return archive_util.make_archive(
  376.             base_name, format, root_dir, base_dir,
  377.             self.verbose, self.dry_run)
  378.  
  379.  
  380.     def make_file (self, infiles, outfile, func, args,
  381.                    exec_msg=None, skip_msg=None, level=1):
  382.         """Special case of 'execute()' for operations that process one or
  383.         more input files and generate one output file.  Works just like
  384.         'execute()', except the operation is skipped and a different
  385.         message printed if 'outfile' already exists and is newer than all
  386.         files listed in 'infiles'.  If the command defined 'self.force',
  387.         and it is true, then the command is unconditionally run -- does no
  388.         timestamp checks.
  389.         """
  390.         if exec_msg is None:
  391.             exec_msg = "generating %s from %s" % \
  392.                        (outfile, string.join (infiles, ', '))
  393.         if skip_msg is None:
  394.             skip_msg = "skipping %s (inputs unchanged)" % outfile
  395.         
  396.  
  397.         # Allow 'infiles' to be a single string
  398.         if type (infiles) is StringType:
  399.             infiles = (infiles,)
  400.         elif type (infiles) not in (ListType, TupleType):
  401.             raise TypeError, \
  402.                   "'infiles' must be a string, or a list or tuple of strings"
  403.  
  404.         # If 'outfile' must be regenerated (either because it doesn't
  405.         # exist, is out-of-date, or the 'force' flag is true) then
  406.         # perform the action that presumably regenerates it
  407.         if self.force or dep_util.newer_group (infiles, outfile):
  408.             self.execute (func, args, exec_msg, level)
  409.  
  410.         # Otherwise, print the "skip" message
  411.         else:
  412.             self.announce (skip_msg, level)
  413.  
  414.     # make_file ()
  415.  
  416. # class Command
  417.  
  418.  
  419. # XXX 'install_misc' class not currently used -- it was the base class for
  420. # both 'install_scripts' and 'install_data', but they outgrew it.  It might
  421. # still be useful for 'install_headers', though, so I'm keeping it around
  422. # for the time being.
  423.  
  424. class install_misc (Command):
  425.     """Common base class for installing some files in a subdirectory.
  426.     Currently used by install_data and install_scripts.
  427.     """
  428.     
  429.     user_options = [('install-dir=', 'd', "directory to install the files to")]
  430.  
  431.     def initialize_options (self):
  432.         self.install_dir = None
  433.         self.outfiles = []
  434.  
  435.     def _install_dir_from (self, dirname):
  436.         self.set_undefined_options('install', (dirname, 'install_dir'))
  437.  
  438.     def _copy_files (self, filelist):
  439.         self.outfiles = []
  440.         if not filelist:
  441.             return
  442.         self.mkpath(self.install_dir)
  443.         for f in filelist:
  444.             self.copy_file(f, self.install_dir)
  445.             self.outfiles.append(os.path.join(self.install_dir, f))
  446.  
  447.     def get_outputs (self):
  448.         return self.outfiles
  449.  
  450.  
  451. if __name__ == "__main__":
  452.     print "ok"
  453.